package com.itany.cloud.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * Author:shixiaojun@itany.com
 * Date:2022/5/28 13:46
 * Version:1.0-SNAPSHOT
 * Description:
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket createRestfulApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                // 选择需要生成的接口所在的包
                // 会对该包下所有的接口功能生成对应的接口文档
                .select()
                // 指定接口所在的包
                .apis(RequestHandlerSelectors.basePackage("com.itany.cloud.controller"))
                // 由于该包下的接口中可能存在一些其他包中的资源
                // 这些资源也需要Swagger进行描述
                // 可以配置级联
                .paths(PathSelectors.any())
                .build();

    }


    /**
     * 创建生成的Restful API接口文档的基本信息
     * 这些信息会在生成的文件中展现
     * 便于开发者使用
     * @return
     */
    public ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                // 标题
                .title("Restful API接口文档")
                // 详细信息
                .description("这是由Swagger2构建的关于用户管理系统相关的Restful API接口文档")
                // 版本号
                .version("1.0-SNAPSHOT")
                // 联系人
                .contact(new Contact("李白","https://www.baidu.com/","123456@qq.com"))
                .build();
    }

}
